home *** CD-ROM | disk | FTP | other *** search
/ CD Ware Multimedia 1995 May / cd Ware (Juegos) Epimundo.iso / DOS / PRGMMING / PCXSHWUP.ZIP / PCXUP.DOC < prev    next >
Encoding:
Text File  |  1994-11-24  |  17.6 KB  |  418 lines

  1.              ╒════════════════════════════════════════════════╕
  2.              │                                                │▐
  3.              │                   PCX-SHOW-UP                  │▐▐
  4.              │   developers' pcx display and startup utility  │▐▐
  5.              │              for DOS applications              │▐▐
  6.              │                                                │▐▐
  7.              │       Copyright (c) 1994 by HME-Software       │▐▐
  8.              │   fax+phone: +49 7121 550520  CIS:100024,3140  │▐▐
  9.              ╘════════════════════════════════════════════════╛▐▐
  10.                ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▐
  11.                  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  12.  
  13.  
  14.  
  15. PCX-SHOW-UP-Capabilities
  16. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  17.  
  18. PCX-SHOW-UP is basically a utility that allows developers of DOS applications
  19. to use standard VGA .pcx files (640x480x16 and 320x200x256) for the two most
  20. wanted purposes:
  21.  
  22.    1. Display a graphic-(VGA .pcx)-copyright or other splashscreen and/or
  23.       some "Loading..." message on the user's screen, while loading and be-
  24.       ginning execution of much larger applications and change the env-
  25.       ironment of this application (SET PATH, SET CLIPPER, SET TEMP, ...).
  26.  
  27.    2. Display a .pcx file from anywhere within the application via the
  28.       'system' or 'run' functions.
  29.  
  30. PCX-SHOW-UP was designed to close the gaps other pcx-viewers leave open when
  31. used to reach this purposes. So it offers the developer a large flexibility
  32. to configure it's use.
  33.  
  34. PCX-SHOW-UP for direct PCX-displays
  35. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  36.  
  37. PCX-SHOW-UP can be called with the following commandline arguments to display
  38. a pcx file directly (from DOS or from within an application):
  39.  
  40.   pcxup [dirve][path]file-name [display-time]
  41.  
  42. The drive, path and display-time parameters are optional. If no drive and path
  43. are given, PCX-SHOW-UP looks in the current directory for the pcx file.
  44. File-name must include an extension; .pcx is not assumed and so you can name
  45. the pcx files how you like (and hide them from end-user modifications <g>).
  46.  
  47. NEW: File-name can now optional include a starting pixel-position and a color-
  48. ▀▀▀▀ number (from your pcx-color-table) for the background. So you can position
  49.      a small pcx anywhere on the screen and choose the background color.
  50.      The format is as follows:
  51.          file-name@x-pos@y-pos@back-color
  52.             file-name  : name of your pcx-file
  53.             [x|y]-pos  : upper-left edge of the display in the clipper-style
  54.                          (x-line# in pixel, y-col# in pixel {is 'byte-aligned'
  55.                          for performance})
  56.             back-color : number of the background color
  57.  
  58. Display-time must be specified in seconds, if no display-time is given,
  59. PCX-SHOW-UP displays the pcx until a key is pressed. (A key-press will always
  60. end the display.)
  61.  
  62. If drive, path or file-name are invalid PCX-SHOW-UP will do nothing.
  63.  
  64.  
  65. PCX-SHOW-UP for application startup-screens
  66. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  67.  
  68. For this purpose PCX-SHOW-UP is called without commandline parameters, it will
  69. then look for your startup-commands in the following way:
  70.  
  71. NEW:   1. For a 'Startup.inf' file compiled directly into the pcxup.exe
  72. ▀▀▀▀
  73.           Syntax for the included 'compinf.exe':
  74.  
  75.            compinf <original-pcxup.exe> <command-file> <new-exe-file>
  76.  
  77.           Compinf will take <command-file> and create a specialized pcxup.exe
  78.           named <new-exe-file> including all commands from <command-file>.
  79.  
  80.  
  81. NEW:   2. For a file named 'exe-name'+'.inf' in 'exe-path', where
  82. ▀▀▀▀          exe-name  is the name of the called pcxup.exe without the
  83.                         extension,
  84.               exe-path  is the drive/path from where the pcxup.exe is
  85.                         called.
  86.           (if you rename pcxup.exe to thebook.exe and place it in
  87.            c:\program\book, it will look for a file 'thebook.inf' in
  88.            c:\program\book to get it's startup-commands from)
  89.  
  90.        3. For a file called 'startup.inf' in the current directory.
  91.  
  92. Syntax for the PCX-SHOW-UP startup-commands (plain-ascii, use any asci-editor
  93. to create a 'startup.inf' file with the commands you want.):
  94.  
  95. 1. '_SHOW_FILE='    followed by the name (optinal including drive/path) of the
  96.                     pcx file to display
  97.  
  98.                     NEW: The name can now optional include a starting pixel-
  99.                     ▀▀▀▀ position and a color- number (from your pcx-color-
  100.                          table) for the background. So you can position a small
  101.                          pcx anywhere on the screen and choose the background
  102.                          color.
  103.  
  104.                          The format is as follows:
  105.                              file-name@x-pos@y-pos@back-color
  106.                                 file-name  : name of your pcx-file
  107.                                 [x|y]-pos  : upper-left edge of the display in
  108.                                              the clipper-style
  109.                                              (x-line# in pixel, y-col# in pixel
  110.                                              {is 'byte-aligned' for perfor-
  111.                                              mance})
  112.                                 back-color : number of the background color
  113.  
  114.                     If this command is not present, then no graphic is dis-
  115.                     played and the following commands '_WAIT_SECONDS' and
  116.                     '_STAY_GRAPHIC' are ignored.
  117.  
  118. 2. '_WAIT_SECONDS=' followed by the number of seconds to display the graphic
  119.                     (000 - 999).
  120.  
  121.                     If this command is not present, PCX-SHOW-UP displays the
  122.                     pcx until a key is pressed. (A key-press will always end
  123.                     the display.)
  124.  
  125. 3. '_STAY_GRAPHIC'  If this command is found, PCX-SHOW-UP displays the pcx and
  126.                     don't switch back to VGA-Text-Mode. This can be used to
  127.                     display the graphic until the real application is loaded
  128.                     and resets/clears the screen.
  129.  
  130.                     If '_STAY_GRAPHIC' is used, the following '_SAY_TEXT='
  131.                     command can't. (in this version - graphic text display is
  132.                     planned for the future...)
  133.  
  134.                     Without this command PCX-SHOW-UP switches back to VGA-TEXT-
  135.                     Mode after '_WAIT_SECONS'.
  136.  
  137. 4. '_SAY_TEXT='     followed by a line of text (80 characters) which is
  138.                     displayed after PCX-SHOW-UP has switched back to VGA-TEXT-
  139.                     Mode.
  140.  
  141.                     This command can be used several times.
  142.  
  143. 5. '_RUN_FILE='     followed by the name (optinal including drive/path) of the
  144.                     application which should be loaded.
  145.  
  146.                     The file-name can be any valid file-name, not only .exe,
  147.                     .com or .bat, so you can rename your application file and
  148.                     hide it from direct calling by end-users.
  149.  
  150.                     Commandline parameters can be passed to the application
  151.                     via the following syntax:
  152.  
  153.                       '_RUN_FILE=app.exe|parameter1|p2|p3|p4|p5|p6|p7|p8|p9'
  154.  
  155.                     This version can pass up to nine parameters to the app.
  156.                     If you need to pass more - call for a special version.
  157.  
  158.                     Don't include any blanks in this command and divide the
  159.                     tokens only with the '|' character (ASCI 124).
  160.  
  161.                     PCX-SHOW-UP loads and executes the application as a new
  162.                     DOS child process. When this is successful, the child
  163.                     process is placed in the memory previously occupied by
  164.                     PCX-SHOW-UP, thus, the application sees NO LOSS of memory,
  165.                     as compared with it running manually from the DOS command
  166.                     line.
  167.  
  168.                     NEW: Searching-routine for the given file-name as follows:
  169.                     ▀▀▀▀
  170.                          File-name can be specified with a full (from the root)
  171.                          or partial path (from the current working dir) or just
  172.                          as a 'file-name'. If file-name does not have an exten-
  173.                          sion or does not end with a period (.), PCX-SHOW-UP
  174.                          searches for the named file; if the search is unsuc-
  175.                          cessful, it tries the same base name, first with the
  176.                          extension .COM, then with the extension .EXE. If the
  177.                          file-name has an extension, only that extension is
  178.                          used in the search. If it ends with a period (.),
  179.                          PCX-SHOW-UP starts the search with no extension.
  180.  
  181.                          PCX-SHOW-UP search for file-name in the directories
  182.                          specified by the PATH env-var. IF file-name contains
  183.                          a drive specifier or any slashes (that is, if it is a
  184.                          relative path), PCX-SHOW-UP searches only for the
  185.                          specified file, the path is not searched.
  186.  
  187. NEW:
  188. ▀▀▀▀
  189. 6. '_CHANGE_ENV='   followed by a number of env-var's you want to add/change
  190.                     in the environment of the '_RUN_FILE'.
  191.  
  192.                     The syntax is as follows:
  193.  
  194.                     '_CHANGE_ENV=PATH=C:\DOS;C:\WINDOWS|CLIPPER= //F:50 //DYNF:4 //SWAPK:4096 //NOIDLE|TMP=C:\WINDOWS\TEMP|...'
  195.  
  196.                     or more formal:
  197.  
  198.                     '_CHANGE_ENV='{env-var-name '=' env-var-value '|'}*
  199.  
  200.                     The line-lenght is limited to 1024 chars. If you need more
  201.                     - call for a special version.
  202.  
  203.                     PCX-SHOW-UP will look for every env-var of your string in
  204.                     the current environment. If it is found, it will be set to
  205.                     your new value, if not it is added with your value.
  206.  
  207.                     You can delete existing env-vars by assigning an empty
  208.                     value to them ('_CHANGE_ENV=CLIPPER=|...').
  209.  
  210.                     Any env-vars you don't assign will be copied as they are.
  211.                     (So if you don't use '_CHANGE_ENV' your current env will
  212.                     be copied.)
  213.  
  214.                     PCX-SHOW-UP will assign this changed-environment to the
  215.                     process of your '_RUN_FILE' (and it's sub-processes) only.
  216.                     Your current master/DOS-environment will not be changed.
  217.  
  218.  
  219. As stated all commands in 'STARTUP.INF' are optional. Don't use any blanks
  220. in the commands (except in your text after _SAY_TEXT= ... <g>) and start
  221. every command in a new line.
  222.  
  223. PCX-SHOW-UP examples
  224. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  225.  
  226. Here are some examples for the different possibilities of PCX-SHOW-UP:
  227.  
  228.   - Just display a pcx-file from the commandline for 30 seconds or till a key
  229.     is pressed:
  230.  
  231.       pcxup c:\windows\pcx\flower.pcx 30
  232.  
  233.   - Display a small logo from the commandline for 30 seconds or till a key
  234.     is pressed at line 100, col 300 and set the background to color# 10 of
  235.     your pcx-color-table:
  236.  
  237.       pcxup c:\windows\pcx\flower.pcx@100@300@10 30
  238.  
  239.   - Display a 'hidden' pcx-file from within a MS-C app until a key is
  240.     pressed:
  241.  
  242.       ...
  243.       cScreen=SaveScreen();
  244.       system("pcxup data\___sys1.sys");
  245.       RestScreen(cScreen);
  246.       ...
  247.  
  248.  
  249.   - Display a 'hidden' pcx-file from within a CA-Clipper app until a key is
  250.     pressed at line 100, col 300 and set the background to color# 10 of
  251.     your pcx-color-table:
  252.  
  253.       ...
  254.       cScreen:=SaveScreen()
  255.       run pcxup data\___sys1.sys@100@300@10
  256.       RestScreen(cScreen)
  257.       ...
  258.  
  259.     or along with provision:Windows()
  260.  
  261.       ...
  262.       pw():suspend()
  263.       run pcxup data\___sys1.sys@100@300@10
  264.       pw():resume()
  265.       ...
  266.  
  267.     and if you like overkill <g> use blinkers 'SwpRunCmd()' or overlays
  268.     'Overlay()' function insteat of the normal Clipper 'run' ...
  269.  
  270.   - Display a 'Loading' message while your large application (app.exe) loads:
  271.  
  272.       Create the following 'STARTUP.INF':
  273.  
  274.       _SAY_TEXT=The large application >app.exe< is now loading from your
  275.       _SAY_TEXT=slow network-server.
  276.       _SAY_TEXT=
  277.       _SAY_TEXT=Please wait...
  278.       _RUN_FILE=app.exe
  279.  
  280.       and call pcxup
  281.  
  282.   - Display a graphic copyright-screen for 20 seconds (or till a key is
  283.     pressed) and then show some loading-message while the real app loads:
  284.  
  285.       Create the following 'STARTUP.INF':
  286.  
  287.       _SHOW_FILE=myfirm.pcx
  288.       _WAIT_SECONDS=20
  289.       _SAY_TEXT=The large application >realapp.exe< is now loading from your
  290.       _SAY_TEXT=slow network-server.
  291.       _SAY_TEXT=
  292.       _SAY_TEXT=Please wait...
  293.       _RUN_FILE=realapp.exe
  294.  
  295.       and call pcxup
  296.  
  297.  
  298.   - Clean up your application directory and prevent the (normal) end-user
  299.     from altering your copyright screens and from calling your app directly.
  300.     Display a graphic copyright-screen for 20 seconds (or till a key is
  301.     pressed) at line 50, col 100 with a background color of 10 and then load
  302.     your app in graphic-mode with path setting of C:\PROGRAM\SPECIAL and a
  303.     CLIPPER setting of '//F:50 //DYNF:4 //SWAPK:4096 //NOIDLE':
  304.  
  305.       move your application files in some 'data' or 'system' directory,
  306.       rename your copyright-pcx to something like '$_msbios.sys' and your
  307.       application file to '_system.sys',rename pcxup.exe to match the name
  308.       of your application (i.e.'yourapp.exe') and
  309.  
  310.       Create the following 'STARTUP.INF':
  311.  
  312.       _SHOW_FILE=data\$_msbios.sys@50@100@10
  313.       _WAIT_SECONDS=20
  314.       _STAY_GRAPHIC
  315.       _RUN_FILE=system\_system.sys
  316.       _CHANGE_ENV=PATH=C:\PROGRAM\SPECIAL|CLIPPER=//F:50 //DYNF:4 //SWAPK:4096 //NOIDLE
  317.  
  318.       Compile it into PCX-SHOW-UP:
  319.  
  320.       compinf c:\util\pcx\pcxup.exe startup.inf yourapp.exe
  321.  
  322.       and call 'yourapp'
  323.  
  324.   - ...
  325.  
  326.  
  327. A word about PCX-Files
  328. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  329.  
  330. PCX-SHOW-UP assumes you wan't feed it a pcx file of a type it can't process.
  331. It is only designed to display standard VGA pcx-files with resolutions of
  332. 640 x 480 and 16 colors or 320 x 200 and 256 colors and as that are the only
  333. standard VGA display modes commonly available to the majority of end-users,
  334. you will most likely not have a problem with this.
  335.  
  336. Quite a few applications that export pcx files create 16 color files in-
  337. correctly, so that any 'well-behaved' pcx viewer (like PCX-SHOW-UP <g>) will
  338. not handle them correctly. If this happens with your application, try to open
  339. and save that file in another program, such as Windows Paintbrush. In almost
  340. all cases this will produce a correct pcx-file.
  341.  
  342. ShareWare vs Registered version
  343. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  344.  
  345. There are no functional differences between these versions except that the
  346. shareware version will display from time to time an copyright screen at
  347. startup. You may test the unregistered version for 30 days.
  348.  
  349. The registration of your copy of PCX-SHOW-UP will allow license for a single
  350. user to make use of the program for purposes that are traditionally accepted
  351. for software utilities of this type.
  352.  
  353. There are no runtime royalties involved in the distribution of registered
  354. PCX-SHOW-UP as part of your application. A notice to your users must be
  355. included in your documentation (electronic or paper) that precludes the use
  356. (or distribution) of PCX-SHOW-UP for any purpose other than running your
  357. software.
  358.  
  359.  
  360. Registration Notes
  361. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  362.  
  363. To obtain a password to the registered version, you must mail an advance
  364. payment registration fee of US$ 40.00 directly to HME Software.  Payment is to
  365. be made by money order only, please.
  366.  
  367. You can also register your copy of PCX-SHOW-UP via Compuserve Shareware
  368. Registration (GO SWREG, Programm ID 3023)
  369.  
  370. Prices and/or registration and/or license fees are subject to change.
  371.  
  372.  
  373. Contact Info
  374. ▀▀▀▀▀▀▀▀▀▀▀▀
  375.  
  376. You can contact us via:
  377.  
  378.     - CompuServe   ID 100024,3140
  379.  
  380.     - Fax          +49 7121 550520
  381.  
  382.     - Phone        +49 7121 550520
  383.  
  384.     - Mail         HME Software / EDV Beratung Morgenstern
  385.                    Pfarrbrunnenweg 9/1
  386.                    D-72770 Reutlingen
  387.                    Germany
  388.  
  389.     - e-mail       HMStar@ACM.org
  390.  
  391.  
  392. Licensing Information
  393. ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  394.  
  395. This program is licensed and supplied as is, without any warranty.  To the
  396. extent permitted under applicable law, HME Software disclaims all warranties,
  397. either expressed or implied, with respect to this software program, its
  398. quality, performance, merchantability, or fitness for any particular purpose.
  399.  
  400. In particular, this software program is not guaranteed to prevent or detect
  401. damage to your data or programs.  In no event shall HME Software be liable
  402. for any claims for lost profits or any damage, including, but not limited to,
  403. special, incidental, consequential or other damage (including, without
  404. limitation, damages for loss of business profits, business interruption, loss
  405. of business information, or other pecuniary loss) arising out of the use of or
  406. inability to use this HME Software product, even if HME Software has been
  407. advised of the possibility of such damages.  Some states do not allow the
  408. exclusion or limitation of incidental or consequential damages, so the above
  409. limitation or exclusion may not apply to you.  In no case shall HME Software
  410. liability exceed the license fees paid for the right to use the licensed
  411. version of the software.
  412.  
  413. This software program is protected under the Copyright Laws of the European
  414. Community and all applicable International Copyright Conventions. Makers
  415. and/or users of illegal or unauthorized copies of the registered version are
  416. subject to prosecution under these laws.
  417.  
  418.